Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
A node library for encoding and decoding bencoded data, according to the BitTorrent specification.
from Wikipedia:
Bencode (pronounced like B encode) is the encoding used by the peer-to-peer file sharing system BitTorrent for storing and transmitting loosely structured data.
It supports four different types of values:
Bencoding is most commonly used in torrent files. These metadata files are simply bencoded dictionaries.
npm install bencode
34,832 op/s » bencode
17,475 op/s » bencoding
15,947 op/s » dht_bencode
15,036 op/s » bncode
21,577 op/s » dht
50,460 op/s » bencode
45,318 op/s » bencoding
60,672 op/s » dht_bencode
2,928 op/s » bncode
49,488 op/s » dht
Benchmarks run on an 2,6 GHz Intel Core i5 with node 5.5.0
To run the benchmarks simply use
npm run bench
var bencode = require( 'bencode' )
You can also use node-bencode with browserify to be able to use it in a lot of modern browsers.
var data = {
string: 'Hello World',
integer: 12345,
dict: {
key: 'This is a string within a dictionary'
},
list: [ 1, 2, 3, 4, 'string', 5, {} ]
}
var result = bencode.encode( data )
NOTE As of bencode@0.8.0
, boolean values will be cast to integers (false -> 0, true -> 1).
d4:dictd3:key36:This is a string within a dictionarye7:integeri12345e4:listli1ei2ei3ei4e6:stringi5edee6:string11:Hello Worlde
var data = new Buffer( 'd6:string11:Hello World7:integeri12345e4:dictd3:key36:This is a string within a dictionarye4:litli1ei2ei3ei4e6:stringi5edeee' )
var result = bencode.decode( data )
{
string: <Buffer 48 65 6c 6c 6f 20 57 6f 72 6c 64>,
integer: 12345,
dict: {
key: <Buffer 54 68 69 73 20 69 73 20 61 20 73 74 72 69 6e 67 20 77 69 74 68 69 6e 20 61 20 64 69 63 74 69 6f 6e 61 72 79>
},
list: [ 1, 2, 3, 4, <Buffer 73 74 72 69 6e 67>, 5, {} ]
}
Automagically convert bytestrings to strings:
var result = bencode.decode( data, 'utf8' )
{
string: 'Hello World',
integer: 12345,
dict: {
key: 'This is a string within a dictionary'
},
list: [ 1, 2, 3, 4, 'string', 5, {} ]
}
The API is compatible with the abstract-encoding
specification.
Buffer
|Array
|String
|Object
|Number
|Boolean
dataBuffer
bufferNumber
offset
Returns Buffer
Buffer
dataNumber
startNumber
endString
encoding
If encoding
is set, bytestrings are
automatically converted to strings.
Returns Object
| Array
| Buffer
| String
| Number
Buffer
|Array
|String
|Object
|Number
|Boolean
value
0.9.0
abstract-encoding
API (@jhermsmeier)FAQs
Bencode de/encoder
The npm package bencode receives a total of 12,399 weekly downloads. As such, bencode popularity was classified as popular.
We found that bencode demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 11 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.